モデル実行の開始

モデルの実行を自動化することができる「Start Execution」エンドポイントです。

POST リクエストでは、モデルの実行設定を制御するためのParameter値を入力することができます。たとえば、どのスニペットのSuiteを実行するかなどです。次のものを指定する必要があります。

• モデルを構築する際に役立つ探索的な実行のための model_id
• 完全に設定されたモデルのための model_id と test_case_id。これら2つのParameterのみで実行を開始すると、モデルは Eggplant Functional のスクリプトに接続せず、モデルを通じたパスのみを生成します。

ノート

Eggplant Functional Suiteに接続する場合は、エージェントを使用して接続を確立し、agentオブジェクトのParameterに値を指定する必要があります。

方法

POST -> http://localhost:8000/execution_service/api/v1/executions

SwaggerでStart Executionエンドポイントを探索することもできます。

http://localhost:8000/execution_service/docs#/Execution/start_execution_execution_service_api_v1_executions_post

ヘッダー

名前	値
Authorization	bearer <access_token>
Content-Type	application/json

ボディParameter

モデルの実行を行うためには、次のParameterのうち少なくとも1つに値を指定して送信する必要があります： model_id、rerun_id、script。

名前	タイプ	説明	必須
execution_type	enumeration	実行のための値は常に executing。
model_id	string	探索的またはテストケース実行に使用するモデルのUUID。	はい
agent	object	モデル実行に使用されるエージェント。	いいえ。null の場合、エージェントは使用されません。
  agent_id	string	使用するエージェント接続のID。	いいえ
  is_hosted_agent	boolean	エージェントがホストされているかローカルマシン上にあるか。	いいえ
test_case_id	integer	テストケース実行に実行するテストケースのID。	いいえ
script	string	スクリプトベースの実行に使用するスクリプトの名前。	いいえ
asset	object	テスト実行に使用するテストアセットの詳細。	いいえ。null の場合、スニペットなしのモデル実行が実行されます。
  asset_version_id	string	使用するアセットバージョンのID。	いいえ
  asset_path	string	接続されたエージェントで使用するSuiteのパス。	いいえ
sut	object	使用するSUTの詳細。	いいえ
  sut_id	string	SUTのID。	いいえ
  criteria	文字列の配列	SUTをロックするための基準またはタグ。これを使用して sut_id の代わりに使用できます。	いいえ
rerun_id	integer	再実行の場合、これは元のモデル実行のテストケースIDです。	いいえ
step_pause_time	integer	内部使用のみ。	いいえ

可能なレスポンス

ステータス	ステータステキスト	説明
200	成功した応答	実行が開始されました。
400	不正なリクエスト	必須のParameterが送信されませんでした。
401	認証されていません	アクセストークンが有効ではありません。
403	アクセスが拒否されました	サーバーがリソースからのアクセスを拒否します。
422	バリデーションエラー	不正確なParameterが送信されました。
503	RabbitMQが利用できません	メッセージサービスが利用できないため、リクエストを完了できません。

レスポンスボディJSON

成功した応答 - ステータス200は開始したモデル実行のIDを返します。

例：

{
    "execution_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}